home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1998 January: Mac OS SDK / Dev.CD Jan 98 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Universal / Interfaces / PInterfaces / Terminals.p < prev    next >
Encoding:
Text File  |  1997-08-12  |  12.1 KB  |  349 lines  |  [TEXT/MPS ]
  1. {
  2.      File:        Terminals.p
  3.  
  4.      Contains:    Communications Toolbox Terminal tool Interfaces.
  5.  
  6.      Version:    Technology:    System 7.5
  7.                  Release:    Universal Interfaces 3.0.1
  8.  
  9.      Copyright:    © 1988-1993, 1995-1997 by Apple Computer, Inc., all rights reserved
  10.  
  11.      Bugs?:        Please include the the file and version information (from above) with
  12.                  the problem description.  Developers belonging to one of the Apple
  13.                  developer programs can submit bug reports to:
  14.  
  15.                      devsupport@apple.com
  16.  
  17. }
  18. {$IFC UNDEFINED UsingIncludes}
  19. {$SETC UsingIncludes := 0}
  20. {$ENDC}
  21.  
  22. {$IFC NOT UsingIncludes}
  23.  UNIT Terminals;
  24.  INTERFACE
  25. {$ENDC}
  26.  
  27. {$IFC UNDEFINED __TERMINALS__}
  28. {$SETC __TERMINALS__ := 1}
  29.  
  30. {$I+}
  31. {$SETC TerminalsIncludes := UsingIncludes}
  32. {$SETC UsingIncludes := 1}
  33.  
  34. {$IFC UNDEFINED __CONDITIONALMACROS__}
  35. {$I ConditionalMacros.p}
  36. {$ENDC}
  37. {$IFC UNDEFINED __DIALOGS__}
  38. {$I Dialogs.p}
  39. {$ENDC}
  40. {$IFC UNDEFINED __CTBUTILITIES__}
  41. {$I CTBUtilities.p}
  42. {$ENDC}
  43. {$IFC UNDEFINED __CONNECTIONS__}
  44. {$I Connections.p}
  45. {$ENDC}
  46.  
  47.  
  48. {$PUSH}
  49. {$ALIGN MAC68K}
  50. {$LibExport+}
  51.  
  52.  
  53. CONST
  54.     curTMVersion                = 2;                            {  current Terminal Manager version  }
  55.  
  56.     curTermEnvRecVers            = 0;                            {  current Terminal Manager Environment Record version  }
  57.  
  58.                                                                 {  error codes     }
  59.     tmGenericError                = -1;
  60.     tmNoErr                        = 0;
  61.     tmNotSent                    = 1;
  62.     tmEnvironsChanged            = 2;
  63.     tmNotSupported                = 7;
  64.     tmNoTools                    = 8;
  65.  
  66.  
  67. TYPE
  68.     TMErr                                = OSErr;
  69.  
  70. CONST
  71.     tmInvisible                    = $01;
  72.     tmSaveBeforeClear            = $02;
  73.     tmNoMenus                    = $04;
  74.     tmAutoScroll                = $08;
  75.     tmConfigChanged                = $10;
  76.  
  77.  
  78. TYPE
  79.     TMFlags                                = LONGINT;
  80.  
  81. CONST
  82.     selTextNormal                = $01;
  83.     selTextBoxed                = $02;
  84.     selGraphicsMarquee            = $04;
  85.     selGraphicsLasso            = $08;
  86.     tmSearchNoDiacrit            = $0100;
  87.     tmSearchNoCase                = $0200;
  88.  
  89.  
  90. TYPE
  91.     TMSearchTypes                        = INTEGER;
  92.     TMSelTypes                            = INTEGER;
  93.  
  94. CONST
  95.     cursorText                    = 1;
  96.     cursorGraphics                = 2;
  97.  
  98.  
  99. TYPE
  100.     TMCursorTypes                        = INTEGER;
  101.  
  102. CONST
  103.     tmTextTerminal                = $01;
  104.     tmGraphicsTerminal            = $02;
  105.  
  106.  
  107. TYPE
  108.     TMTermTypes                            = INTEGER;
  109.     TermDataBlockPtr = ^TermDataBlock;
  110.     TermDataBlock = RECORD
  111.         flags:                    TMTermTypes;
  112.         theData:                Handle;
  113.         auxData:                Handle;
  114.         reserved:                LONGINT;
  115.     END;
  116.  
  117.     TermDataBlockH                        = ^TermDataBlockPtr;
  118.     TermDataBlockHandle                    = ^TermDataBlockPtr;
  119.     TermEnvironRecPtr = ^TermEnvironRec;
  120.     TermEnvironRec = RECORD
  121.         version:                INTEGER;
  122.         termType:                TMTermTypes;
  123.         textRows:                INTEGER;
  124.         textCols:                INTEGER;
  125.         cellSize:                Point;
  126.         graphicSize:            Rect;
  127.         slop:                    Point;
  128.         auxSpace:                Rect;
  129.     END;
  130.  
  131.     TermEnvironPtr                        = ^TermEnvironRec;
  132.     TMSelectionPtr = ^TMSelection;
  133.     TMSelection = RECORD
  134.         CASE INTEGER OF
  135.         0: (
  136.             selRect:            Rect;
  137.             );
  138.         1: (
  139.             selRgnHandle:        RgnHandle;
  140.             );
  141.     END;
  142.  
  143.     TermRecordPtr = ^TermRecord;
  144.     TermPtr                                = ^TermRecord;
  145.     TermHandle                            = ^TermPtr;
  146.     TerminalSendProcPtr = ProcPtr;  { FUNCTION TerminalSend(thePtr: Ptr; theSize: LONGINT; refCon: LONGINT; flags: CMFlags): LONGINT; }
  147.  
  148.     TerminalBreakProcPtr = ProcPtr;  { PROCEDURE TerminalBreak(duration: LONGINT; refCon: LONGINT); }
  149.  
  150.     TerminalCacheProcPtr = ProcPtr;  { FUNCTION TerminalCache(refCon: LONGINT; theTermData: TermDataBlockPtr): LONGINT; }
  151.  
  152.     TerminalSearchCallBackProcPtr = ProcPtr;  { PROCEDURE TerminalSearchCallBack(hTerm: TermHandle; refNum: INTEGER; VAR foundRect: Rect); }
  153.  
  154.     TerminalClikLoopProcPtr = ProcPtr;  { FUNCTION TerminalClikLoop(refCon: LONGINT): BOOLEAN; }
  155.  
  156.     TerminalEnvironsProcPtr = ProcPtr;  { FUNCTION TerminalEnvirons(refCon: LONGINT; VAR theEnvirons: ConnEnvironRec): CMErr; }
  157.  
  158.     TerminalChooseIdleProcPtr = ProcPtr;  { PROCEDURE TerminalChooseIdle; }
  159.  
  160.     TerminalToolDefProcPtr = ProcPtr;  { FUNCTION TerminalToolDef(hTerm: TermHandle; msg: INTEGER; p1: LONGINT; p2: LONGINT; p3: LONGINT): LONGINT; }
  161.  
  162.     TerminalSendUPP = UniversalProcPtr;
  163.     TerminalBreakUPP = UniversalProcPtr;
  164.     TerminalCacheUPP = UniversalProcPtr;
  165.     TerminalSearchCallBackUPP = UniversalProcPtr;
  166.     TerminalClikLoopUPP = UniversalProcPtr;
  167.     TerminalEnvironsUPP = UniversalProcPtr;
  168.     TerminalChooseIdleUPP = UniversalProcPtr;
  169.     TerminalToolDefUPP = UniversalProcPtr;
  170. {    TMTermTypes     }
  171.     TermRecord = RECORD
  172.         procID:                    INTEGER;
  173.         flags:                    TMFlags;
  174.         errCode:                TMErr;
  175.         refCon:                    LONGINT;
  176.         userData:                LONGINT;
  177.         defProc:                TerminalToolDefUPP;
  178.         config:                    Ptr;
  179.         oldConfig:                Ptr;
  180.         environsProc:            TerminalEnvironsUPP;
  181.         reserved1:                LONGINT;
  182.         reserved2:                LONGINT;
  183.         tmPrivate:                Ptr;
  184.         sendProc:                TerminalSendUPP;
  185.         breakProc:                TerminalBreakUPP;
  186.         cacheProc:                TerminalCacheUPP;
  187.         clikLoop:                TerminalClikLoopUPP;
  188.         owner:                    WindowPtr;
  189.         termRect:                Rect;
  190.         viewRect:                Rect;
  191.         visRect:                Rect;
  192.         lastIdle:                LONGINT;
  193.         selection:                TMSelection;
  194.         selType:                TMSelTypes;
  195.         mluField:                LONGINT;
  196.     END;
  197.  
  198.  
  199. CONST
  200.     uppTerminalSendProcInfo = $00002FF0;
  201.     uppTerminalBreakProcInfo = $000003C0;
  202.     uppTerminalCacheProcInfo = $000003F0;
  203.     uppTerminalSearchCallBackProcInfo = $00000EC0;
  204.     uppTerminalClikLoopProcInfo = $000000D0;
  205.     uppTerminalEnvironsProcInfo = $000003E0;
  206.     uppTerminalChooseIdleProcInfo = $00000000;
  207.     uppTerminalToolDefProcInfo = $0000FEF0;
  208.  
  209. FUNCTION NewTerminalSendProc(userRoutine: TerminalSendProcPtr): TerminalSendUPP;
  210.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  211.     INLINE $2E9F;
  212.     {$ENDC}
  213.  
  214. FUNCTION NewTerminalBreakProc(userRoutine: TerminalBreakProcPtr): TerminalBreakUPP;
  215.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  216.     INLINE $2E9F;
  217.     {$ENDC}
  218.  
  219. FUNCTION NewTerminalCacheProc(userRoutine: TerminalCacheProcPtr): TerminalCacheUPP;
  220.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  221.     INLINE $2E9F;
  222.     {$ENDC}
  223.  
  224. FUNCTION NewTerminalSearchCallBackProc(userRoutine: TerminalSearchCallBackProcPtr): TerminalSearchCallBackUPP;
  225.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  226.     INLINE $2E9F;
  227.     {$ENDC}
  228.  
  229. FUNCTION NewTerminalClikLoopProc(userRoutine: TerminalClikLoopProcPtr): TerminalClikLoopUPP;
  230.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  231.     INLINE $2E9F;
  232.     {$ENDC}
  233.  
  234. FUNCTION NewTerminalEnvironsProc(userRoutine: TerminalEnvironsProcPtr): TerminalEnvironsUPP;
  235.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  236.     INLINE $2E9F;
  237.     {$ENDC}
  238.  
  239. FUNCTION NewTerminalChooseIdleProc(userRoutine: TerminalChooseIdleProcPtr): TerminalChooseIdleUPP;
  240.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  241.     INLINE $2E9F;
  242.     {$ENDC}
  243.  
  244. FUNCTION NewTerminalToolDefProc(userRoutine: TerminalToolDefProcPtr): TerminalToolDefUPP;
  245.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  246.     INLINE $2E9F;
  247.     {$ENDC}
  248.  
  249. FUNCTION CallTerminalSendProc(thePtr: Ptr; theSize: LONGINT; refCon: LONGINT; flags: CMFlags; userRoutine: TerminalSendUPP): LONGINT;
  250.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  251.     INLINE $205F, $4E90;
  252.     {$ENDC}
  253.  
  254. PROCEDURE CallTerminalBreakProc(duration: LONGINT; refCon: LONGINT; userRoutine: TerminalBreakUPP);
  255.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  256.     INLINE $205F, $4E90;
  257.     {$ENDC}
  258.  
  259. FUNCTION CallTerminalCacheProc(refCon: LONGINT; theTermData: TermDataBlockPtr; userRoutine: TerminalCacheUPP): LONGINT;
  260.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  261.     INLINE $205F, $4E90;
  262.     {$ENDC}
  263.  
  264. PROCEDURE CallTerminalSearchCallBackProc(hTerm: TermHandle; refNum: INTEGER; VAR foundRect: Rect; userRoutine: TerminalSearchCallBackUPP);
  265.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  266.     INLINE $205F, $4E90;
  267.     {$ENDC}
  268.  
  269. FUNCTION CallTerminalClikLoopProc(refCon: LONGINT; userRoutine: TerminalClikLoopUPP): BOOLEAN;
  270.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  271.     INLINE $205F, $4E90;
  272.     {$ENDC}
  273.  
  274. FUNCTION CallTerminalEnvironsProc(refCon: LONGINT; VAR theEnvirons: ConnEnvironRec; userRoutine: TerminalEnvironsUPP): CMErr;
  275.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  276.     INLINE $205F, $4E90;
  277.     {$ENDC}
  278.  
  279. PROCEDURE CallTerminalChooseIdleProc(userRoutine: TerminalChooseIdleUPP);
  280.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  281.     INLINE $205F, $4E90;
  282.     {$ENDC}
  283.  
  284. FUNCTION CallTerminalToolDefProc(hTerm: TermHandle; msg: INTEGER; p1: LONGINT; p2: LONGINT; p3: LONGINT; userRoutine: TerminalToolDefUPP): LONGINT;
  285.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  286.     INLINE $205F, $4E90;
  287.     {$ENDC}
  288.  
  289. FUNCTION InitTM: TMErr;
  290. FUNCTION TMGetVersion(hTerm: TermHandle): Handle;
  291. FUNCTION TMGetTMVersion: INTEGER;
  292. FUNCTION TMNew({CONST}VAR termRect: Rect; {CONST}VAR viewRect: Rect; flags: TMFlags; procID: INTEGER; owner: WindowPtr; sendProc: TerminalSendUPP; cacheProc: TerminalCacheUPP; breakProc: TerminalBreakUPP; clikLoop: TerminalClikLoopUPP; environsProc: TerminalEnvironsUPP; refCon: LONGINT; userData: LONGINT): TermHandle;
  293. PROCEDURE TMDispose(hTerm: TermHandle);
  294. PROCEDURE TMKey(hTerm: TermHandle; {CONST}VAR theEvent: EventRecord);
  295. PROCEDURE TMUpdate(hTerm: TermHandle; visRgn: RgnHandle);
  296. PROCEDURE TMPaint(hTerm: TermHandle; {CONST}VAR theTermData: TermDataBlock; {CONST}VAR theRect: Rect);
  297. PROCEDURE TMActivate(hTerm: TermHandle; activate: BOOLEAN);
  298. PROCEDURE TMResume(hTerm: TermHandle; resume: BOOLEAN);
  299. PROCEDURE TMClick(hTerm: TermHandle; {CONST}VAR theEvent: EventRecord);
  300. PROCEDURE TMIdle(hTerm: TermHandle);
  301. FUNCTION TMStream(hTerm: TermHandle; theBuffer: UNIV Ptr; theLength: LONGINT; flags: CMFlags): LONGINT;
  302. FUNCTION TMMenu(hTerm: TermHandle; menuID: INTEGER; item: INTEGER): BOOLEAN;
  303. PROCEDURE TMReset(hTerm: TermHandle);
  304. PROCEDURE TMClear(hTerm: TermHandle);
  305. PROCEDURE TMResize(hTerm: TermHandle; {CONST}VAR newViewRect: Rect);
  306. FUNCTION TMGetSelect(hTerm: TermHandle; theData: Handle; VAR theType: ResType): LONGINT;
  307. PROCEDURE TMGetLine(hTerm: TermHandle; lineNo: INTEGER; VAR theTermData: TermDataBlock);
  308. PROCEDURE TMSetSelection(hTerm: TermHandle; {CONST}VAR theSelection: TMSelection; selType: TMSelTypes);
  309. PROCEDURE TMScroll(hTerm: TermHandle; dh: INTEGER; dv: INTEGER);
  310. FUNCTION TMValidate(hTerm: TermHandle): BOOLEAN;
  311. PROCEDURE TMDefault(VAR theConfig: Ptr; procID: INTEGER; allocate: BOOLEAN);
  312. FUNCTION TMSetupPreflight(procID: INTEGER; VAR magicCookie: LONGINT): Handle;
  313. PROCEDURE TMSetupSetup(procID: INTEGER; theConfig: UNIV Ptr; count: INTEGER; theDialog: DialogPtr; VAR magicCookie: LONGINT);
  314. FUNCTION TMSetupFilter(procID: INTEGER; theConfig: UNIV Ptr; count: INTEGER; theDialog: DialogPtr; VAR theEvent: EventRecord; VAR theItem: INTEGER; VAR magicCookie: LONGINT): BOOLEAN;
  315. PROCEDURE TMSetupItem(procID: INTEGER; theConfig: UNIV Ptr; count: INTEGER; theDialog: DialogPtr; VAR theItem: INTEGER; VAR magicCookie: LONGINT);
  316. PROCEDURE TMSetupXCleanup(procID: INTEGER; theConfig: UNIV Ptr; count: INTEGER; theDialog: DialogPtr; OKed: BOOLEAN; VAR magicCookie: LONGINT);
  317. PROCEDURE TMSetupPostflight(procID: INTEGER);
  318. FUNCTION TMGetConfig(hTerm: TermHandle): Ptr;
  319. FUNCTION TMSetConfig(hTerm: TermHandle; thePtr: UNIV Ptr): INTEGER;
  320. FUNCTION TMIntlToEnglish(hTerm: TermHandle; inputPtr: UNIV Ptr; VAR outputPtr: Ptr; language: INTEGER): OSErr;
  321. FUNCTION TMEnglishToIntl(hTerm: TermHandle; inputPtr: UNIV Ptr; VAR outputPtr: Ptr; language: INTEGER): OSErr;
  322. PROCEDURE TMGetToolName(id: INTEGER; VAR name: Str255);
  323. FUNCTION TMGetProcID(name: ConstStr255Param): INTEGER;
  324. PROCEDURE TMSetRefCon(hTerm: TermHandle; refCon: LONGINT);
  325. FUNCTION TMGetRefCon(hTerm: TermHandle): LONGINT;
  326. PROCEDURE TMSetUserData(hTerm: TermHandle; userData: LONGINT);
  327. FUNCTION TMGetUserData(hTerm: TermHandle): LONGINT;
  328. FUNCTION TMAddSearch(hTerm: TermHandle; theString: ConstStr255Param; {CONST}VAR where: Rect; searchType: TMSearchTypes; callBack: TerminalSearchCallBackUPP): INTEGER;
  329. PROCEDURE TMRemoveSearch(hTerm: TermHandle; refnum: INTEGER);
  330. PROCEDURE TMClearSearch(hTerm: TermHandle);
  331. FUNCTION TMGetCursor(hTerm: TermHandle; cursType: TMCursorTypes): Point;
  332. FUNCTION TMGetTermEnvirons(hTerm: TermHandle; VAR theEnvirons: TermEnvironRec): TMErr;
  333. FUNCTION TMChoose(VAR hTerm: TermHandle; where: Point; idleProc: TerminalChooseIdleUPP): INTEGER;
  334. PROCEDURE TMEvent(hTerm: TermHandle; {CONST}VAR theEvent: EventRecord);
  335. FUNCTION TMDoTermKey(hTerm: TermHandle; theKey: ConstStr255Param): BOOLEAN;
  336. FUNCTION TMCountTermKeys(hTerm: TermHandle): INTEGER;
  337. PROCEDURE TMGetIndTermKey(hTerm: TermHandle; id: INTEGER; VAR theKey: Str255);
  338. PROCEDURE TMGetErrorString(hTerm: TermHandle; id: INTEGER; VAR errMsg: Str255);
  339. {$ALIGN RESET}
  340. {$POP}
  341.  
  342. {$SETC UsingIncludes := TerminalsIncludes}
  343.  
  344. {$ENDC} {__TERMINALS__}
  345.  
  346. {$IFC NOT UsingIncludes}
  347.  END.
  348. {$ENDC}
  349.